Skip to content

Automate the update of docs/index.md #492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jun 30, 2022
Merged

Automate the update of docs/index.md #492

merged 4 commits into from
Jun 30, 2022

Conversation

cesclass
Copy link
Contributor

Description

Implement a technical (CI) feature to maintain the documentation updated. #490

  • Add a script to simplify the update process.
  • Fix/Update the README.md and docs/index.md.
  • Add a workflow to check that the index is up to date.

Checklist

Note to maintainers

  • Read this wiki page
  • Make sure the PR has a milestone
  • Assign yourself before merging
  • We can squash-merge 1-commit PRs (use a header with a conventional-commit type, add a footer with Fix #… if need be)

erikmd
erikmd requested changes Jun 28, 2022
View reviewed changes
Copy link
Member

@erikmd erikmd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cesclass !

Your PR is good, but I left a number of details to fix/improve.

Feel free to add commits / rebase -i and force-push

cesclass and others added 4 commits June 30, 2022 11:13
@cesclass @erikmd
ci(update-index.sh): Add a script to update docs/index.md
c538200 
Related: ocaml-sf#490

Co-authored-by: Erik Martin-Dorel <[email protected]>
@cesclass
docs(README.md): Update/Fix README.md
7174547 
* Add missing links in "Howtos" from docs/index.md

* Fix URLs format in "License and copyright"

* Remove unnecessary spaces before bullet list elements
@cesclass
docs(index.md): Update index.md
2fdc853 
* Update index.md with the updated README.md using update-index.sh
@cesclass @erikmd
ci(check-update-index.yml): Add a workflow to check index.md
24c56b3 
* The workflow check out the repo and execute update-index.sh.
  Then it check the diffs using git diff on index.md.

Related: ocaml-sf#490

Co-authored-by: Erik Martin-Dorel <[email protected]>
@cesclass cesclass requested a review from erikmd June 30, 2022 09:39
erikmd
erikmd approved these changes Jun 30, 2022
View reviewed changes
Copy link
Member

@erikmd erikmd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good, thanks @cesclass

@erikmd erikmd self-assigned this Jun 30, 2022
@erikmd erikmd added kind: enhancement Enhancement to an existing user-facing feature. kind: infrastructure CI, build tools, development tools labels Jun 30, 2022
@erikmd erikmd added this to the learn-ocaml 0.15.0 milestone Jun 30, 2022
@erikmd erikmd merged commit dd16e46 into ocaml-sf:master Jun 30, 2022
@erikmd erikmd deleted the index-update branch June 30, 2022 16:56
@erikmd erikmd changed the title Index update Automate the update of docs/index.md Jun 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erikmd erikmd erikmd approved these changes

Assignees

@erikmd erikmd

Labels
kind: enhancement Enhancement to an existing user-facing feature. kind: infrastructure CI, build tools, development tools
Projects
None yet
Milestone
learn-ocaml 0.14.1
Development

Successfully merging this pull request may close these issues.

Feature (Technical Story): Automate the update of index.md
2 participants
@cesclass @erikmd